[fivetran] Revamp docs by koletzilla · Pull Request #5777 · ClickHouse/clickhouse-docs

koletzilla · 2026-03-18T18:49:18Z

Revamp Fivetran docs:

Index cover more details about the current version and related files
Reference covers all the docs we have in Fivetran side: configurations, table engine details...
- I have not moved the full setup-guide, only the configurations details. The full guide should be kept complete in Fivetran side as it's really nice to have it when editing the connector.
Troubleshooting contains usual errors with possible solutions, good practices and some examples to help debugging.

vercel · 2026-03-18T18:49:25Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
clickhouse-docs	Ready	Preview, Comment	Mar 31, 2026 10:19am
clickhouse-docs-jp	Building	Preview, Comment	Mar 31, 2026 10:19am

3 Skipped Deployments

Project	Deployment	Actions	Updated (UTC)
clickhouse-docs-ko	Ignored	Preview	Mar 31, 2026 10:19am
clickhouse-docs-ru	Ignored	Preview	Mar 31, 2026 10:19am
clickhouse-docs-zh	Ignored	Preview	Mar 31, 2026 10:19am

dhtclk

Just a few minor nits on voice and grammar, as well as the use of the note admonition.

docs/integrations/data-ingestion/etl-tools/fivetran/index.md

docs/integrations/data-ingestion/etl-tools/fivetran/reference.md

docs/integrations/data-ingestion/etl-tools/fivetran/index.md

docs/integrations/data-ingestion/etl-tools/fivetran/troubleshooting.md

koletzilla · 2026-03-24T09:48:25Z

Thanks for all these suggested changes @dhtclk 🙇

docs/integrations/data-ingestion/etl-tools/fivetran/reference.md

BentsiLeviav

Left a few comments/questions.
In addition, can we go over the code and track errors we raise, and document them with an explanation in the troubleshooting guide? (if they are not here already)

docs/integrations/data-ingestion/etl-tools/fivetran/reference.md

docs/integrations/data-ingestion/etl-tools/fivetran/troubleshooting.md

koletzilla · 2026-03-27T18:11:59Z

@BentsiLeviav I have checked the errors sent by the server and I feel most of them should not be documented, but I have included in the Troubleshooting section a few ones.

Included:

Grants tests failing.
Error while waiting for all mutations to be completed.
Column mismatch/Type incompatibility/Column not found.

Not included:

Related to configuration: All shown in the UI during test
- Host should not contain protocol or port: already included in the web
- Host should not contain path
- Port must be a number in range [1, 65535]
- Failed to parse advanced config
- Configuration value out of allowed range
Related to connection errors: Needs basic checks
- Error while opening a connection to ClickHouse
- ClickHouse connection error
- Connection test failed
Related to cluster & replication errors: Situation controlled
- Error while waiting for all nodes to be available
Related to data processing errors: internal fivetran error that a user doesn't have control of and may be fixed after a retry.
- Can't parse value
- No target type for column
- Batch operation errors
- Retry exhaustion
- Failed to write batch / Failed to write history batch
Related to table operation errors: Shouldn't happen, but as these are grants related, it's explained in the grant section
- Failed to create table
- Failed to alter table
- Failed to truncate
Related to file processing errors: Internal errors to manage with Fivetran
- Failed to open / decrypt / decompress CSV file
- Empty CSV file without header

For future reference in case of needed: this is the full .md generated by Claude for all the errors mentioned: error-reference.md

dhtclk

Just did another small pass and pointed out a few corrections, once these are done I'll approve so you're not double blocked.

docs/integrations/data-ingestion/etl-tools/fivetran/reference.md

docs/integrations/data-ingestion/etl-tools/fivetran/troubleshooting.md

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>

…oting.md Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>

…re as it's internally managed.

…created in History mode

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>

…oting.md Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>

koletzilla · 2026-03-31T10:48:12Z

Thanks again for checking it, @dhtclk! I appreciate your willingness to unlock the PR, but I'd like to wait for full approval from @BentsiLeviav just to confirm that the content is aligned with expectations.

koletzilla changed the title ~~Revamp Fiventran docs~~ [fivetran] Revamp docs Mar 18, 2026

vercel bot had a problem deploying to Preview – clickhouse-docs March 18, 2026 18:50 Failure

vercel bot had a problem deploying to Preview – clickhouse-docs March 19, 2026 10:49 Failure

vercel bot deployed to Preview – clickhouse-docs March 19, 2026 14:21 View deployment

koletzilla force-pushed the clickhouse/improve-fivetran-docs branch from 74bf704 to 659f3d2 Compare March 20, 2026 18:41

koletzilla requested a review from BentsiLeviav March 20, 2026 18:45

koletzilla marked this pull request as ready for review March 20, 2026 18:45

koletzilla requested review from a team as code owners March 20, 2026 18:45

vercel bot had a problem deploying to Preview – clickhouse-docs March 20, 2026 18:51 Failure

vercel bot had a problem deploying to Preview – clickhouse-docs March 23, 2026 09:59 Failure

vercel bot deployed to Preview – clickhouse-docs March 23, 2026 11:03 View deployment

dhtclk requested changes Mar 23, 2026

View reviewed changes

vercel bot deployed to Preview – clickhouse-docs March 24, 2026 10:08 View deployment

BentsiLeviav reviewed Mar 24, 2026

View reviewed changes

BentsiLeviav requested changes Mar 24, 2026

View reviewed changes

docs/integrations/data-ingestion/etl-tools/fivetran/reference.md Outdated Show resolved Hide resolved

docs/integrations/data-ingestion/etl-tools/fivetran/troubleshooting.md Outdated Show resolved Hide resolved

vercel bot had a problem deploying to Preview – clickhouse-docs March 26, 2026 15:45 Failure

vercel bot had a problem deploying to Preview – clickhouse-docs March 26, 2026 15:58 Failure

vercel bot deployed to Preview – clickhouse-docs March 26, 2026 16:53 View deployment

vercel bot deployed to Preview – clickhouse-docs March 27, 2026 14:46 View deployment

koletzilla force-pushed the clickhouse/improve-fivetran-docs branch from f26cdbb to a048bdc Compare March 27, 2026 14:55

vercel bot had a problem deploying to Preview – clickhouse-docs March 27, 2026 15:06 Failure

vercel bot had a problem deploying to Preview – clickhouse-docs March 27, 2026 15:41 Failure

vercel bot deployed to Preview – clickhouse-docs March 27, 2026 16:02 View deployment

vercel bot had a problem deploying to Preview – clickhouse-docs March 27, 2026 17:49 Failure

vercel bot deployed to Preview – clickhouse-docs March 27, 2026 18:02 View deployment

dhtclk reviewed Mar 30, 2026

View reviewed changes

koletzilla and others added 21 commits March 31, 2026 12:04

first version for the draft

263e1a5

Improve index.html, fix links, fix lint

a87c1d9

lint

601afc5

Finish docs. Remove setup-guide to let that live in Fivetran side

4310b97

lint

bcc8e6e

Fix links

00576dc

link

de0d5ff

Update docs/integrations/data-ingestion/etl-tools/fivetran/index.md

98aeca6

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>

Update docs/integrations/data-ingestion/etl-tools/fivetran/reference.md

e66bbb9

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>

Update docs/integrations/data-ingestion/etl-tools/fivetran/index.md

cbaac14

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>

Update docs/integrations/data-ingestion/etl-tools/fivetran/troublesho…

793d0f2

…oting.md Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>

Clarify date and type mappings

2c933ba

lint

b45fbcf

lint

625b755

Improve explanations for query optimizations changes.

53bb2c7

Remove: "Ensure cluster health during syncs". It's not applying anymo…

08bc7df

…re as it's internally managed.

lint

cbac2ea

lint

e615e18

Add more possible errors

1421ea2

lint + message clarification

4b1403e

Include in reference.md the explanation of the schema for the tables …

49b7eae

…created in History mode

koletzilla force-pushed the clickhouse/improve-fivetran-docs branch from a952d15 to 49b7eae Compare March 31, 2026 10:04

koletzilla and others added 3 commits March 31, 2026 12:04

Update docs/integrations/data-ingestion/etl-tools/fivetran/reference.md

b24030a

Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>

Update docs/integrations/data-ingestion/etl-tools/fivetran/troublesho…

d1b88c6

…oting.md Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>

Update docs/integrations/data-ingestion/etl-tools/fivetran/troublesho…

1b4186f

…oting.md Co-authored-by: Dominic Tran <dominic.tran@clickhouse.com>

vercel bot deployed to Preview – clickhouse-docs March 31, 2026 10:19 View deployment

Conversation

koletzilla commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Mar 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dhtclk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

koletzilla commented Mar 24, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BentsiLeviav left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

koletzilla commented Mar 27, 2026

Uh oh!

dhtclk left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

koletzilla commented Mar 31, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

koletzilla commented Mar 18, 2026 •

edited

Loading

vercel bot commented Mar 18, 2026 •

edited

Loading

dhtclk left a comment •

edited

Loading